Add typos checks by bircni · Pull Request #36874 · go-gitea/gitea

bircni · 2026-03-09T21:23:16Z

As requested by @lunny in #36783 I added a typos check

We currently cannot solve all old typos - please tell me if there are some which I would be allowd to fix
For now I only tried to fix some non-breaking ones

TheFox0x7

This needs more sane way of ignoring base64 strings.

TheFox0x7 · 2026-03-09T22:38:32Z

_typos.toml

+helo = "helo"
+Helo = "Helo"
+HELO = "HELO"


one of them should be enough

TheFox0x7 · 2026-03-09T22:39:01Z

_typos.toml

+cpy = "cpy"
+odf = "odf"
+# SunOS SMF framework property name
+startd = "startd"


it's ignored though?

TheFox0x7 · 2026-03-09T22:57:02Z

_typos.toml

+[default.extend-identifiers]
+# util.Iif is ternary helper; cannot change: public API
+Iif = "Iif"
+iif = "iif"
+# determineSHAforPR function name; cannot change: public API
+SHAforPR = "SHAforPR"
+Afor = "Afor"


dead rules?

TheFox0x7 · 2026-03-09T22:57:58Z

_typos.toml

+# ARIA attribute aria-activedescendant; HTML standard
+actived = "actived"
+Actived = "Actived"


bad comment, all the mentions I see refer to dropped column in database.

TheFox0x7 · 2026-03-09T23:01:03Z

_typos.toml

+# File extension / format name (e.g. Clojure edn, Makefile .mak)
+edn = "edn"
+mak = "mak"
+cpy = "cpy"
+odf = "odf"


Suggested change

# File extension / format name (e.g. Clojure edn, Makefile .mak)

edn = "edn"

mak = "mak"

cpy = "cpy"

odf = "odf"

TheFox0x7 · 2026-03-09T23:01:34Z

_typos.toml

+# File extension / icon name in material-icon-rules.json
+stap = "stap"


Suggested change

# File extension / icon name in material-icon-rules.json

stap = "stap"

# File extension / icon name in material-icon-rules.json

stap = "stap"

edn = "edn"

mak = "mak"

cpy = "cpy"

rcall = "rcall"

caf = "caf"

TheFox0x7 · 2026-03-09T23:02:12Z

_typos.toml

+caf = "caf"
+claus = "claus"
+Claus = "Claus"
+rcall = "rcall"


Suggested change

caf = "caf"

claus = "claus"

Claus = "Claus"

rcall = "rcall"

TheFox0x7 · 2026-03-09T23:02:30Z

_typos.toml

+# Substring in base64 or test data (false positive)
+Ot = "Ot"
+nd = "nd"
+Nd = "Nd"
+ND = "ND"
+iy = "iy"
+Iy = "Iy"
+ba = "ba"
+BA = "BA"
+Pn = "Pn"
+Iz = "Iz"
+ue = "ue"
+Ue = "Ue"
+Mis = "Mis"
+Ser = "Ser"
+Yto = "Yto"
+fo = "fo"
+ist = "ist"
+Ein = "Ein"
+noo = "noo"
+oder = "oder"
+ono = "ono"
+ags = "ags"
+alle = "alle"
+ALLWAYS = "ALLWAYS"


while typos has indeed problem with base64 this is not a good approach.
It's a huge bag of items which at times are base64 garbage, are test data or emoji data while it skips a real issue of "Mis" in "Mis-configured".
ALLWAYS is should not be labeled as test data since it's an old config key.

TheFox0x7 · 2026-03-09T23:03:23Z

_typos.toml

+# Migration function RemoveLabelUneededCols; cannot rename
+Uneeded = "Uneeded"
+# Emoji shortcode "womens" (women's room) in emoji_data.go
+womens = "womens"


Suggested change

womens = "womens"

womens = "womens"

claus = "claus"

TheFox0x7 · 2026-03-09T23:04:19Z

_typos.toml

+# TypoScript is a CMS project name, not a typo of TypeScript
+TypoScript = "TypoScript"
+# Meilisearch ranking rule name
+typo = "typo"
+# TYPO3 CMS project name
+TYPO3 = "TYPO3"
+Typo3 = "Typo3"


dead rules?

silverwind · 2026-03-10T05:54:52Z

We already have misspell as a spellchecker and one thing I like about it is it has a near-zero rate of false-positives. I tried integrating other spellcheckers before but always gave up on their enormous rate of false-positives.

I think we should not have to babysit a spell checker configuration. If this one works well, I'm not against switching to it, but it needs to be absolutely robust.

wxiaoguang · 2026-03-10T06:51:47Z

_typos.toml

+unparseable = "unparseable"
+# i18n key used in all locale files; cannot change key
+enterred = "enterred"
+# Substring in base64 or test data (false positive)


No. Don't do this.

silverwind · 2026-03-10T19:06:22Z

.github/workflows/pull-compliance.yml

+      - name: Typos check
+        uses: crate-ci/typos@v1.44.0
+        with:
+          config: _typos.toml


No action-only checks please. Run it during make lint-spell and remove this step. That way it can be ran locally which is very important.

You probably need to add a cargo.toml to pin this tool dependency, similar to what we already do for python using pyproject.toml.

Also if possible integrate it into make lint-spell-fix to automatically fix all errors.

No action-only checks please

lint-typos was added in the PR so it's runnable locally. Not sure why it's a separate rule and it doesn't cover installation (which I don't mind) but it does exist.

Ah, I missed that, was only seeing this.

bircni · 2026-03-10T19:21:29Z

Closing this as typos-cli does not cover all features we want it to have - would be a nice thing to have but not possible in the condition as typos-cli currently is

bircni added 3 commits March 9, 2026 22:19

Add typos configuration and linting support

3f2ff61

fix typos part 1

55d8286

correctly document ignores

76bbf94

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 9, 2026

github-actions bot added modifies/go Pull requests that update Go code modifies/docs modifies/internal labels Mar 9, 2026

exclude typos.toml from lint checks

6575a83

TheFox0x7 suggested changes Mar 9, 2026

View reviewed changes

GiteaBot added lgtm/blocked A maintainer has reservations with the PR and thus it cannot be merged and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Mar 9, 2026

wxiaoguang reviewed Mar 10, 2026

View reviewed changes

silverwind reviewed Mar 10, 2026

View reviewed changes

bircni closed this Mar 10, 2026

		# File extension / icon name in material-icon-rules.json
		stap = "stap"

Uh oh!

Conversation

bircni commented Mar 9, 2026

Uh oh!

TheFox0x7 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bircni commented Mar 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

silverwind commented Mar 10, 2026 •

edited

Loading

silverwind Mar 10, 2026 •

edited

Loading